home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / datatypes / cdt / doc / c_dtc.doc next >
Text File  |  1996-04-07  |  5KB  |  113 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. c.datatype/c.datatype
  6.  
  7.  
  8. c.datatype/c.datatype                                      c.datatype/c.datatype
  9.  
  10.     NAME
  11.         c.datatype - data type for any c source
  12.  
  13.     FUNCTION
  14.         This datatype is designed to display C and C++ source codes. It
  15.         display's different parts of the C source in different style and
  16.         color.At the moment these parts are :
  17.            STANDARD - any text which, doesn't match the following parts
  18.            COMMENT  - any comment such like /* ... */ and // ...
  19.            CPP      - any C-PreProcessor keyword like "#define" or "#include"
  20.            KEYWORD  - any C/C++ keyword, which isn't handled explicitly
  21.            STORAGE  - extern,static,register,auto keywords
  22.            TYPES    - basic type keywords like int,char,long etc.
  23.            TYPENAME - any name following a struct,union,class or enum
  24.            STRING   - any string or char literal
  25.            NUMBER   - any number constant decimal,hex
  26.            HEADER   - any include filename
  27.  
  28.         It uses a parser generated by bison with my yacc grammer.Because it's
  29.         a parser, it may occur a parse error on some unusual source code. If
  30.         this happens please send me a description of this parse error and
  31.         maybe the input file. So I can fix this problem !
  32.  
  33.     PREFS
  34.         The c.prefs file is searched first in PROGDIR:Prefs/DataTypes/ and
  35.         then in Env:DataTypes/ with the following five ReadArgs() templates :
  36.  
  37.         - CPART/A/K,PEN/N/K,R=RED/N/K,G=GREEN/N/K,B=BLUE/N/K,BGPEN/N/K,
  38.           BGR=BGRED/N/K,BGG=BGGREEN/N/K,BGB=BGBLUE/N/K,ITALIC/S,BOLD/S,
  39.           UNDERLINED/S,TEXT/S
  40.  
  41.           CPART is one of the explaned cpart names like COMMENT or CPP.
  42.           PEN assigns the color with the pen number to the specified part
  43.           R,G,B defines a new color for the specified part. This color is
  44.                 allocated with ObtainBestPenA(...,OBP_Precision,
  45.                                                   PRECISION_ICON);
  46.           BGPEN same as PEN, but for background
  47.           BGR,BGG,BGB defines a new background color for the specified part.
  48.                 This color is allocated with ObtainBestPenA(...,OBP_Precision,
  49.                                                             PRECISION_ICON);
  50.           ITALIC,BOLD,UNDERLINED specifies the font style for the part
  51.           TEXT treat this CPART as normal text
  52.  
  53.         - GLOBAL/A/S,TABLENGTH/N/K,NONESTEDCOMMENTS/S
  54.  
  55.           GLOBAL indicates, that this line is a global setting. Note: The
  56.               /A/S combination isn't supported from ReadArgs(), so I check
  57.               it manually !
  58.           TABLENGTH - number of spaces to use for a tab !
  59.           NONESTEDCOMMENTS - disables nested comments
  60.  
  61.         - INLINEARGS/A/S,KEYWORD/K/A,PATTERN/K/A,LINES/N/K
  62.  
  63.           INLINEARGS indicates ,that this line is a inline args setting
  64.           KEYWORD defines the keyword to search for the inlined arguments for
  65.               the first lines. You can specify any string, which is compared
  66.               using strcmp(). After the keyword follows directly the pattern
  67.               specified by PATTERN.
  68.           PATTERN defines the pattern to get the inlined arguments. Any char
  69.               in the pattern must match the char in the text after the
  70.               keyword. To get any arguments you can specify a template using
  71.               the '%' char like in scanf() function. Following options are
  72.               supported :
  73.                   %t - stands for the TABLENGTH
  74.                   %c - stands for NESTEDCOMMENTS or NONESTEDCOMMENTS
  75.           LINES - specifies the number of lines from the beginning scanned
  76.               for inline arguments. Default is 10.
  77.  
  78.         - USERTYPES/A/S,TYPES/M
  79.  
  80.           USERTYPES indicates, that this line contains user defined types
  81.  
  82.           TYPES defines words to treat as basic types like int or long etc.
  83.  
  84.         - USERKEYWORDS/A/S,KEYWORDS/M
  85.  
  86.           USERKEYWORDS indicates, that this line contains user defined
  87.               keywords
  88.  
  89.           KEYWORDS defines words to treat as keywords like return etc.
  90.  
  91.         - USERSTORAGE/A/S,STORAGE/M
  92.  
  93.           USERSTORAGE indicates, that this line contains user defined
  94.               storage keywords
  95.  
  96.           STORAGE defines words to treat as storage keywords like static or
  97.               register
  98.  
  99.     HISTORY
  100.         see doc/c.datatype.rev
  101.  
  102.     AUTHOR
  103.         Stefan Ruppert
  104.         Windthorststrasse 5
  105.         65439 Floersheim am Main
  106.         Germany
  107.         EMail: i511@informatik.fh-wiesbaden.de
  108.         or     ruppert@gundel.zdv.uni-mainz.de
  109.  
  110.     SEE ALSO
  111.         text.datatype
  112.  
  113.